46장 제너레이터와 asyncawait
제너레이터란 ?
es6에서 도입된 코드 블록의 실행을 일시 중지 했다가 필요한 시점에 재개할 수 있는 특수한 함수이다.
- 제너테이터 함수는 함수 호출자에게 함수 실행의 제어권을 양도할 수 있다.
- 일반 함수 : 호출하면 제어권이 함수에게 넘어가고 caller(호출자)는 호출 이후 함수를 제어할 수 없다.
- 제너레이터 : caller가 함수 실행을 중지시키거나 재개할 수 있음. 즉, 함수의 제어권을 caller에게 양도할 수 있다.
- 제너레이터 함수는 함수 호출자와 함수의 상태를 주고받을 수 있다.
- 일반 함수 : 매개변수로 외부에서 값 주입, return 으로 외부로 반환.
- 제너레이터 : caller와 양방향으로 함수 상태 주고받을 수 있음.
- 제너레이터 함수를 호출하면 제너레이터 객체를 반환한다.
- 일반 함수 : 함수 코드 실행하고 값 반환
- 제너레이터 : 함수 호출하면 코드 실행하는 게 아니라 이터러블이면서 동시에 이터레이터인 제너레이터 객체를 반환한다.
제너레이터 함수 정의
funcion* 로 선언하고 1개 이상의 yield 를 포함한다.
// 제너레이터 함수 선언문
function* genDecFunc() {
yield 1;
}
// 제너레이터 함수 표현식
const genExpFunc = function* () {
yield 1;
};
// 제너레이터 메서드
const obj = {
* genObjMethod() {
yield 1;
}
};
// 제너레이터 클래스 메서드
class MyClass {
* genClsMethod() {
yield 1;
}
}
- function 키워드와 함수 이름 사이에만 * 가 있기만 하면됨. 위치 상관 X
- 화살표 함수로 정의할 수 없음
- 제너레이터 함수는 new 연산자와 함께 생성자 함수로 호출 X
function* genFunc() {
yield 1;
}
new genFunc(); // TypeError: genFunc is not a constructor
제너레이터 객체
제너레이터 함수 호출하면 제너레이터 객체 생성해서 반환한다.
제너레이터 객체는 이터러블 이면서 동시에 이터레이터이다. 34장 이터러블
즉, 제너레이터 객체는 Symbol.iterator 메서드를 상속받고, value,done 프로퍼티를 갖는 이터레이터 리절트 객체를 반환하는 next메서드를 소유한다.
// 제너레이터 함수
function* genFunc() {
yield 1;
yield 2;
yield 3;
}
// 제너레이터 함수를 호출하면 제너레이터 객체를 반환한다.
const generator = genFunc();
// 제너레이터 객체는 이터러블이면서 동시에 이터레이터다.
// 이터러블은 Symbol.iterator 메서드를 직접 구현하거나 프로토타입 체인을 통해 상속받은 객체다.
console.log(Symbol.iterator in generator); // true
// 이터레이터는 next 메서드를 갖는다.
console.log('next' in generator); // true
제너레이터 객체는 이터레이터지만 이터레이터에 없는 return throw 메서드를 갖는다.
- next 메서드 호출하면
yield까지 코드 블록 실행하고 yield 된 값을 value프로퍼티 값으로 false를 done 프로퍼티 값으로 갖는 이터레이터 리절트 객체 반환 - return 메서드 호출하면 인수로 전달받은 값을 value로, true를 done 프로퍼티 값으로 갖는 이터레이터 리절트 객체 반환.
⇒ next 호출하면 yield가 한단계씩 전진하면서 yield값 반환
⇒ return 호출하면 인수 반환하면서 done true 줘서 끝내버리기
function* genFunc() {
try {
yield 1;
yield 2;
yield 3;
} catch (e) {
console.error(e);
}
}
const generator = genFunc();
console.log(generator.next()); // {value: 1, done: false}
console.log(generator.return('End!')); // {value: "End!", done: true}
- thorw 메서드 호출하면 인수로 전달받은 에러 발생시키고 { value : undefined, done : true }인 이터레이터 result 객체 반환
function* genFunc() {
try {
yield 1;
yield 2;
yield 3;
} catch (e) {
console.error(e);
}
}
const generator = genFunc();
console.log(generator.next()); // {value: 1, done: false}
console.log(generator.throw('Error!')); // {value: undefined, done: true}
제너레이터의 일시 중지와 재개
제너레이터 함수는 모든 코드를 일괄 실행하는 것이 아니라, yield 표현식 까지만 실행. next 메서드 실행하면 다음 yield 표현식 까지만 실행하고 제어권을 넘겨준다.
즉, yield 표현식은 함수 실행 일시 중지 시키고 yield 뒤에 오는 표현식의 결과를 호출자에게 반환
// 제너레이터 함수
function* genFunc() {
yield 1;
yield 2;
yield 3;
}
// 제너레이터 함수를 호출하면 제너레이터 객체를 반환한다.
// 이터러블이면서 동시에 이터레이터인 제너레이터 객체는 next 메서드를 갖는다.
const generator = genFunc();
// 처음 next 메서드를 호출하면 첫 번째 yield 표현식까지 실행되고 일시 중지된다.
// next 메서드는 이터레이터 리절트 객체({value, done})를 반환한다.
// value 프로퍼티에는 첫 번째 yield 표현식에서 yield된 값 1이 할당된다.
// done 프로퍼티에는 제너레이터 함수가 끝까지 실행되었는지를 나타내는 false가 할당된다.
console.log(generator.next()); // {value: 1, done: false}
// 다시 next 메서드를 호출하면 두 번째 yield 표현식까지 실행되고 일시 중지된다.
// next 메서드는 이터레이터 리절트 객체({value, done})를 반환한다.
// value 프로퍼티에는 두 번째 yield 표현식에서 yield된 값 2가 할당된다.
// done 프로퍼티에는 제너레이터 함수가 끝까지 실행되었는지를 나타내는 false가 할당된다.
console.log(generator.next()); // {value: 2, done: false}
// 다시 next 메서드를 호출하면 세 번째 yield 표현식까지 실행되고 일시 중지된다.
// next 메서드는 이터레이터 리절트 객체({value, done})를 반환한다.
// value 프로퍼티에는 세 번째 yield 표현식에서 yield된 값 3이 할당된다.
// done 프로퍼티에는 제너레이터 함수가 끝까지 실행되었는지를 나타내는 false가 할당된다.
console.log(generator.next()); // {value: 3, done: false}
// 다시 next 메서드를 호출하면 남은 yield 표현식이 없으므로 제너레이터 함수의 마지막까지 실행한다.
// next 메서드는 이터레이터 리절트 객체({value, done})를 반환한다.
// value 프로퍼티에는 제너레이터 함수의 반환값 undefined가 할당된다.
// done 프로퍼티에는 제너레이터 함수가 끝까지 실행되었음을 나타내는 true가 할당된다.
console.log(generator.next()); // {value: undefined, done: true}
value는 yield 값, done은 제너레이터 함수가 끝까지 실행되었는지 나타내는 불리언값 할당 된다.
제너레이터 객체의 next 메서드에는 인수 전달 할 수 있음. 전달된 인수는 yield 표현식을 할당받는 변수에 할당된다.
function* genFunc() {
// 처음 next 메서드를 호출하면 첫 번째 yield 표현식까지 실행되고 일시 중지된다.
// 이때 yield된 값 1은 next 메서드가 반환한 이터레이터 리절트 객체의 value 프로퍼티에 할당된다.
// x 변수에는 아직 아무것도 할당되지 않았다. x 변수의 값은 next 메서드가 두 번째 호출될 때 결정된다.
const x = yield 1;
// 두 번째 next 메서드를 호출할 때 전달한 인수 10은 첫 번째 yield 표현식을 할당받는 x 변수에 할당된다.
// 즉, const x = yield 1;은 두 번째 next 메서드를 호출했을 때 완료된다.
// 두 번째 next 메서드를 호출하면 두 번째 yield 표현식까지 실행되고 일시 중지된다.
// 이때 yield된 값 x + 10은 next 메서드가 반환한 이터레이터 리절트 객체의 value 프로퍼티에 할당된다.
const y = yield (x + 10);
// 세 번째 next 메서드를 호출할 때 전달한 인수 20은 두 번째 yield 표현식을 할당받는 y 변수에 할당된다.
// 즉, const y = yield (x + 10);는 세 번째 next 메서드를 호출했을 때 완료된다.
// 세 번째 next 메서드를 호출하면 함수 끝까지 실행된다.
// 이때 제너레이터 함수의 반환값 x + y는 next 메서드가 반환한 이터레이터 리절트 객체의 value 프로퍼티에 할당된다.
// 일반적으로 제너레이터의 반환값은 의미가 없다.
// 따라서 제너레이터에서는 값을 반환할 필요가 없고 return은 종료의 의미로만 사용해야 한다.
return x + y;
}
// 제너레이터 함수를 호출하면 제너레이터 객체를 반환한다.
// 이터러블이며 동시에 이터레이터인 제너레이터 객체는 next 메서드를 갖는다.
const generator = genFunc(0);
// 처음 호출하는 next 메서드에는 인수를 전달하지 않는다.
// 만약 처음 호출하는 next 메서드에 인수를 전달하면 무시된다.
// next 메서드가 반환한 이터레이터 리절트 객체의 value 프로퍼티에는 첫 번째 yield된 값 1이 할당된다.
let res = generator.next();
console.log(res); // {value: 1, done: false}
// next 메서드에 인수로 전달한 10은 genFunc 함수의 x 변수에 할당된다.
// next 메서드가 반환한 이터레이터 리절트 객체의 value 프로퍼티에는 두 번째 yield된 값 20이 할당된다.
res = generator.next(10);
console.log(res); // {value: 20, done: false}
// next 메서드에 인수로 전달한 20은 genFunc 함수의 y 변수에 할당된다.
// next 메서드가 반환한 이터레이터 리절트 객체의 value 프로퍼티에는 제너레이터 함수의 반환값 30이 할당된다.
res = generator.next(20);
console.log(res); // {value: 30, done: true}
처음에는 잘 이해가 안됐다.
const x = yield 1 이면 x에 1이 할당되는 줄 알았는데 아니였다.
const x = yield 1 에서 변수 x에 대한 할당은 첫번째 next에서 일어나지 않는다. yield 1 까지만 진행되고 할당부분은 다음 next에서 인수로 보낸 값에 의해서 일어난다. 다음 const x = 다음 next의 인수 가 되는 것이다.
즉 , next와 yield를 사용해서 함수와 상태를 주고 받을 수 있는 것이다.
이러한 특성을 활용해서 비동기 처리를 동기 처럼 구현할 수 있다고 한다.
제너레이터의 활용
이터러블의 구현
제너레이터 함수 사용하면 이터레이션 프로토콜 준수해서 이터러블 생성하는 방법보다 간단하게 이터러블을 구현할 수 있다고 한다.
아래 코드는 피보나치 수열 생성하는 함수이다.
// 무한 이터러블을 생성하는 함수
const infiniteFibonacci = (function () {
let [pre, cur] = [0, 1];
return {
[Symbol.iterator]() { return this; },
next() {
[pre, cur] = [cur, pre + cur];
// 무한 이터러블이므로 done 프로퍼티를 생략한다.
return { value: cur };
}
};
}());
// infiniteFibonacci는 무한 이터러블이다.
for (const num of infiniteFibonacci) {
if (num > 10000) break;
console.log(num); // 1 2 3 5 8...2584 4181 6765
}
yield의 특성을 활용해서 쉽게 만들 수 있다.
// 무한 이터러블을 생성하는 제너레이터 함수
const infiniteFibonacci = (function* () {
let [pre, cur] = [0, 1];
while (true) {
[pre, cur] = [cur, pre + cur];
yield cur;
}
}());
// infiniteFibonacci는 무한 이터러블이다.
for (const num of infiniteFibonacci) {
if (num > 10000) break;
console.log(num); // 1 2 3 5 8...2584 4181 6765
}
비동기 처리
caller와 함수가 상태를 주고받을 수 있다는 특성을 활용해서 Promise를 활용한 비동기 처리를 동기 처리처럼 구현할 수 있다. → 프로미스의 후속 처리 메서드 없이 비동기 처리 결과 반환하게 할 수 있다.
// node-fetch는 node.js 환경에서 window.fetch 함수를 사용하기 위한 패키지다.
// 브라우저 환경에서 이 예제를 실행한다면 아래 코드는 필요 없다.
// https://github.com/node-fetch/node-fetch
const fetch = require('node-fetch');
// 제너레이터 실행기
const async = generatorFunc => {
const generator = generatorFunc(); // ②
const onResolved = arg => {
const result = generator.next(arg); // ⑤
return result.done
? result.value // ⑨
: result.value.then(res => onResolved(res)); // ⑦
};
return onResolved; // ③
};
(async(function* fetchTodo() { // ①
const url = 'https://jsonplaceholder.typicode.com/todos/1';
const response = yield fetch(url); // ⑥
const todo = yield response.json(); // ⑧
console.log(todo);
// {userId: 1, id: 1, title: 'delectus aut autem', completed: false}
})()); // ④
동작순서는 다음과 같다.
- async 함수 호출하면 fetchTodo 제너레이터함수를 인자로 전달받은 다음에 제너레이터 객체 생성.
- onResolved 함수를 반환. onResolved 함수는 generator 변수를 기억하는 클로저. async에서 onResolved함수 즉시 호출(④)해서 generator 객체의 next 메서드 호출(⑤)
- next 메서드 처음 호출되면 fetch 한 결과 값을 반환. { value : fetch 값 , done : false }(⑥). onResolved 함수에서 done이 false 이므로 value값으로 재귀(⑦).
- onResolved 함수에서 fetch값을 인수로 next 메서드 실행(⑤). fetchTodo함수의 response에 인수 할당.(⑥). 2번째 yield 반환 (⑧).
- done이 false 이므로 다시 onResolved 재귀(⑦). fetchTodo 함수의 todo에 response.json 할당. { value : undefined, done : true} 반환 후 종료. done이 ture이므로 재귀 종료(⑨)
async와 yield의 모습과 작동 과정을 보면 async/await가 생각난다! 그렇다 바로 이 원리다.
만약 제너레이터 실행기가 필요하면 직접 구현보다 co 라이브러리 사용하는 걸 권장한다고 한다.
const fetch = require('node-fetch');
// https://github.com/tj/co
const co = require('co');
co(function* fetchTodo() {
const url = 'https://jsonplaceholder.typicode.com/todos/1';
const response = yield fetch(url);
const todo = yield response.json();
console.log(todo);
// { userId: 1, id: 1, title: 'delectus aut autem', completed: false }
});
async/await
제너레이터 사용해서 비동기 처리를 동기처럼 동작하게 했지만 코드가 더럽다.
→ 제너레이터보다 간단하게 비동기처리를 동기처럼 동작하도록 구현할 수있는 async/await가 도입됐다.
async/await는 프로미스를 기반으로 동작하지만 프로미스의 후속처리 메서드에 콜백함수를 전달할 필요없이 동기 처럼 프로미스를 사용할 수 있다.
const fetch = require('node-fetch');
async function fetchTodo() {
const url = 'https://jsonplaceholder.typicode.com/todos/1';
const response = await fetch(url);
const todo = await response.json();
console.log(todo);
// {userId: 1, id: 1, title: 'delectus aut autem', completed: false}
}
fetchTodo();
async 함수
- await 키워드는 async 함수 내부에서만 사용 가능
- async 함수는 항상 프로미스를 반환.
return값이 프로미스가 아니라면 return 값을 resolve하는 프로미스를 반환
// async 함수 선언문
async function foo(n) { return n; }
foo(1).then(v => console.log(v)); // 1
// async 함수 표현식
const bar = async function (n) { return n; };
bar(2).then(v => console.log(v)); // 2
// async 화살표 함수
const baz = async n => n;
baz(3).then(v => console.log(v)); // 3
// async 메서드
const obj = {
async foo(n) { return n; }
};
obj.foo(4).then(v => console.log(v)); // 4
// async 클래스 메서드
class MyClass {
async bar(n) { return n; }
}
const myClass = new MyClass();
myClass.bar(5).then(v => console.log(v)); // 5
클래스의 constructor 메서드는 async 메서드가 될 수 없다.
→ constructor는 인스턴스를 반환해야하는데 async는 프로미스 반환해야해서 충돌된다.
class MyClass {
async constructor() { }
// SyntaxError: Class constructor may not be an async method
}
const myClass = new MyClass();
await 키워드
await키워드는 대기하다가 프로미스가 settled상태가 되면 프로미스가 resolve한 결과를 반환한다.
반드시 프로미스 앞에서 사용해야 한다.
const fetch = require('node-fetch');
const getGithubUserName = async id => {
const res = await fetch(`https://api.github.com/users/${id}`); // ①
const { name } = await res.json(); // ②
console.log(name); // Ungmo Lee
};
getGithubUserName('ungmo2');
① 에서 fetch 반환한 프로미스가 settled상태가 될 때까지 대기하다가 res에 할당
즉, awiat는 다음 실행을 일시 중지 시켰다가 프로미스가 settled 상태가 되면 재개한다.
async function foo() {
const a = await new Promise(resolve => setTimeout(() => resolve(1), 3000));
const b = await new Promise(resolve => setTimeout(() => resolve(2), 2000));
const c = await new Promise(resolve => setTimeout(() => resolve(3), 1000));
console.log([a, b, c]); // [1, 2, 3]
}
foo(); // 약 6초 소요된다.
프로미스가 settled 상태가 될 때까지 실행을 중지시켜서 위의 경우 1초 + 2초 + 3초 총 6초의 시간이 소요된다.
위의 경우 처럼 3개의 비동기 처리가 서로에게 연관이 없을 경우 모든 프로미스에 await를 사용하는 것은 비효율 적이다.
이럴 경우에는 Promise.all을 사용해서 처리하는 것이 좋다.
async function foo() {
const res = await Promise.all([
new Promise(resolve => setTimeout(() => resolve(1), 3000)),
new Promise(resolve => setTimeout(() => resolve(2), 2000)),
new Promise(resolve => setTimeout(() => resolve(3), 1000))
]);
console.log(res); // [1, 2, 3]
}
foo(); // 약 3초 소요된다.
만약 비동기 처리의 연관성을 가져서 다음 비동기 처리 순서가 보장되어야할 경우에 await를 사용해준다.
async function bar(n) {
const a = await new Promise(resolve => setTimeout(() => resolve(n), 3000));
// 두 번째 비동기 처리를 수행하려면 첫 번째 비동기 처리 결과가 필요하다.
const b = await new Promise(resolve => setTimeout(() => resolve(a + 1), 2000));
// 세 번째 비동기 처리를 수행하려면 두 번째 비동기 처리 결과가 필요하다.
const c = await new Promise(resolve => setTimeout(() => resolve(b + 1), 1000));
console.log([a, b, c]); // [1, 2, 3]
}
bar(1); // 약 6초 소요된다.
에러처리
비동기 처리를 위한 콜백패턴의 단점 중 하나는 에러 처리이다.
에러는 caller 방향으로 전파된다. 즉, 콜 스택에서의 아래방향(바로 직전에 푸시된 실행컨텍스트방향) 으로 전파되는데, 비동기 함수는 콜백함수를 호출하고 그것이 완료되기 전에 호출스택을 빠져나가서 에러 케치가 어렵다.
try {
setTimeout(() => { throw new Error('Error!'); }, 1000);
} catch (e) {
// 에러를 캐치하지 못한다
console.error('캐치한 에러', e);
}
async/await에서는 프로미스를 반환하는 비동기 함수를 명시적으로 호출할 수 있어서 async/await 를 사용할 수 있다.
const fetch = require('node-fetch');
const foo = async () => {
try {
const wrongUrl = 'https://wrong.url';
const response = await fetch(wrongUrl);
const data = await response.json();
console.log(data);
} catch (err) {
console.error(err); // TypeError: Failed to fetch
}
};
foo();
async 함수 내에서 try cathc문 사용하지 않을 때 async 함수는 발생한 에러를 reject하는 프로미스를 반환하게 때문에 프로미스 후속 처리 메서드 사용해서 에러 캐치할 수도 있다.
const fetch = require('node-fetch');
const foo = async () => {
const wrongUrl = 'https://wrong.url';
const response = await fetch(wrongUrl);
const data = await response.json();
return data;
};
foo()
.then(console.log)
.catch(console.error); // TypeError: Failed to fetch